Edits to roadmap and about page #231
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
May 23, 2017 16:06
broccolini
approved these changes
May 24, 2017
Contributor
broccolini
left a comment
There was a problem hiding this comment.
Left a couple of small comments, otherwise looks good 👍
about/index.html
Outdated
| <h3 id="who">Who</h3> | ||
|
|
||
| <p>Currently maintained by <a href="https://twitter.com/mdo">@mdo</a>, <a href="https://twitter.com/jonrohan">@jonrohan</a>, and the GitHub CSS team.</p> | ||
| <p>Maintained by GitHub Design Systems team.</p> |
Contributor
There was a problem hiding this comment.
"Maintained by the GitHub Design Systems team?
about/index.html
Outdated
| <h3 id="what-and-why">What and why</h3> | ||
|
|
||
| <p>See the <a href="/roadmap">roadmap</a> for a rough outline on what’s slated for future versions of Primer.</p> | ||
| <p>Primer is GitHub’s internal CSS framework. It includes basic global styling for typography, small components like buttons and tabs, and our general guidelines for writing HTML and CSS. It’s been used internally at GitHub for years now.</p> |
Contributor
There was a problem hiding this comment.
I'd remove "small" from "small components". Some of them are big! Do you want to add utilities in there?
about/index.html
Outdated
| <li>Autoprefixer is used to generate vendor-prefixed declarations and is handled via our Gruntfile.</li> | ||
| <li>A custom plugin for snippet and example combos, <code class="highlighter-rouge">example.rb</code>, was created as a fork of Jekyll’s built-in <code class="highlighter-rouge">highlight</code> plugin.</li> | ||
| </ul> | ||
| <p>Primer is currently being overhauled. The upcoming version of Primer will add new styles and bring the existing styles up to date, improve the build process, and include new and improved documentation. This will be open-sourced and shared with the community when it's complete, currently slated to happen in mid-to-late 2017.</p> |
Contributor
There was a problem hiding this comment.
Not a big deal, but all the styles are already open sourced. You could re-phrase the last sentence to this:
"New styles will be open-sourced in the Primer repo and on NPM as we add them, and the new documentation site will be shared when it's complete,..."
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR removes the roadmap and out-of-date content from the about page of our docs. We have had a few issues created by primer users due to these inaccurate pages. I've also added some copy to explain that we're currently overhauling Primer and that we will release that when it's ready.
Note: I am making this changes directly to the
gh-pagesbranch, which is the built version of our docs. (Source files are on[docs_branch](https://github.com/primer/primer-css/tree/docs_branch/)) I'm doing this to avoid re-building our docs. When I did this locally, it imported new primer CSS, which then broke styles within the docs. Since we will be relaunching with a whole new docs site and build process, and therefore unlikely to rebuild these docs, I think editinggh-pagesdirectly is safest for now. (But I realize it's far from a good practice!)cc/ @primer/design-systems